Skip to content

Extend doc with examples#497

Merged
AlexInLog merged 1 commit into
v2from
extend_doc
Dec 22, 2023
Merged

Extend doc with examples#497
AlexInLog merged 1 commit into
v2from
extend_doc

Conversation

@AlexInLog

@AlexInLog AlexInLog commented Dec 22, 2023

Copy link
Copy Markdown
Owner

No description provided.

@github-actions

github-actions Bot commented Dec 22, 2023

Copy link
Copy Markdown
Contributor

BENCHMARK RESULTS (AUTOGENERATED)

ci-ubuntu-gcc

General
name rxcpp rpp prev rpp ratio
Subscribe empty callbacks to empty observable 304.70 ns 1.24 ns 1.24 ns 1.00
Subscribe empty callbacks to empty observable via pipe operator 325.91 ns 1.24 ns 1.23 ns 1.01

Sources
name rxcpp rpp prev rpp ratio
from array of 1 - create + subscribe + immediate 770.62 ns 0.63 ns 0.62 ns 1.02
from array of 1 - create + subscribe + current_thread 1031.19 ns 4.67 ns 4.63 ns 1.01
concat_as_source of just(1 immediate) create + subscribe 2372.19 ns 80.37 ns 82.47 ns 0.97
defer from array of 1 - defer + create + subscribe + immediate 741.10 ns 0.31 ns 0.31 ns 1.02
interval - interval + take(3) + subscribe + immediate 2135.00 ns 58.09 ns 58.00 ns 1.00
interval - interval + take(3) + subscribe + current_thread 3085.04 ns 32.43 ns 32.12 ns 1.01

Filtering Operators
name rxcpp rpp prev rpp ratio
immediate_just+take(1)+subscribe 1074.60 ns 0.31 ns 0.31 ns 1.00
immediate_just+filter(true)+subscribe 854.43 ns 0.31 ns 0.31 ns 1.00
immediate_just(1,2)+skip(1)+subscribe 988.04 ns 0.31 ns 0.31 ns 1.00
immediate_just(1,1,2)+distinct_until_changed()+subscribe 847.84 ns 0.31 ns 0.31 ns 1.00
immediate_just(1,2)+first()+subscribe 1232.40 ns 0.62 ns 0.62 ns 1.00
immediate_just(1,2)+last()+subscribe 928.24 ns 0.31 ns 0.31 ns 1.01
immediate_just+take_last(1)+subscribe 1123.19 ns 17.90 ns 18.52 ns 0.97

Schedulers
name rxcpp rpp prev rpp ratio
immediate scheduler create worker + schedule 280.23 ns 1.23 ns 1.24 ns 1.00
current_thread scheduler create worker + schedule 379.85 ns 5.63 ns 5.56 ns 1.01
current_thread scheduler create worker + schedule + recursive schedule 805.63 ns 63.35 ns 64.42 ns 0.98

Transforming Operators
name rxcpp rpp prev rpp ratio
immediate_just+map(v*2)+subscribe 867.55 ns 0.31 ns 0.31 ns 1.00
immediate_just+scan(10, std::plus)+subscribe 895.97 ns 0.31 ns 0.31 ns 1.00
immediate_just+flat_map(immediate_just(v*2))+subscribe 2344.21 ns 97.46 ns 97.66 ns 1.00
immediate_just+buffer(2)+subscribe 1525.43 ns 13.61 ns 14.23 ns 0.96
immediate_just+window(2)+subscribe + subscsribe inner 2447.20 ns 687.13 ns 698.16 ns 0.98

Conditional Operators
name rxcpp rpp prev rpp ratio
immediate_just+take_while(false)+subscribe 837.19 ns - - 0.00
immediate_just+take_while(true)+subscribe 853.40 ns 0.31 ns 0.31 ns 1.02

Utility Operators
name rxcpp rpp prev rpp ratio
immediate_just(1)+subscribe_on(immediate)+subscribe 1995.46 ns 0.31 ns 0.31 ns 1.00

Combining Operators
name rxcpp rpp prev rpp ratio
immediate_just(immediate_just(1), immediate_just(1)) + merge() + subscribe 3386.87 ns 116.76 ns 113.70 ns 1.03
immediate_just(1) + merge_with(immediate_just(2)) + subscribe 3670.76 ns 109.23 ns 109.38 ns 1.00
immediate_just(1) + with_latest_from(immediate_just(2)) + subscribe - 86.91 ns 88.90 ns 0.98
immediate_just(immediate_just(1),immediate_just(1)) + switch_on_next() + subscribe 3542.98 ns 524.41 ns 551.59 ns 0.95

Subjects
name rxcpp rpp prev rpp ratio
publish_subject with 1 observer - on_next 34.51 ns 23.54 ns 23.55 ns 1.00

Scenarios
name rxcpp rpp prev rpp ratio
basic sample 1428.04 ns 14.81 ns 14.81 ns 1.00
basic sample with immediate scheduler 1430.30 ns 5.55 ns 5.55 ns 1.00

Aggregating Operators
name rxcpp rpp prev rpp ratio
immediate_just+reduce(10, std::plus)+subscribe 920.06 ns 0.31 ns 0.31 ns 1.00

ci-macos

General
name rxcpp rpp prev rpp ratio
Subscribe empty callbacks to empty observable 972.43 ns 3.03 ns 3.03 ns 1.00
Subscribe empty callbacks to empty observable via pipe operator 973.19 ns 3.03 ns 3.03 ns 1.00

Sources
name rxcpp rpp prev rpp ratio
from array of 1 - create + subscribe + immediate 1935.85 ns 0.24 ns 0.24 ns 1.03
from array of 1 - create + subscribe + current_thread 2444.87 ns 25.76 ns 25.72 ns 1.00
concat_as_source of just(1 immediate) create + subscribe 5341.93 ns 245.24 ns 253.64 ns 0.97
defer from array of 1 - defer + create + subscribe + immediate 1933.83 ns 0.23 ns 0.23 ns 0.97
interval - interval + take(3) + subscribe + immediate 4820.64 ns 113.36 ns 117.99 ns 0.96
interval - interval + take(3) + subscribe + current_thread 5897.53 ns 107.21 ns 115.57 ns 0.93

Filtering Operators
name rxcpp rpp prev rpp ratio
immediate_just+take(1)+subscribe 2843.09 ns 0.23 ns 0.25 ns 0.92
immediate_just+filter(true)+subscribe 2110.07 ns 0.23 ns 0.27 ns 0.86
immediate_just(1,2)+skip(1)+subscribe 2686.46 ns 0.23 ns 0.28 ns 0.82
immediate_just(1,1,2)+distinct_until_changed()+subscribe 2021.96 ns 0.46 ns 0.56 ns 0.81
immediate_just(1,2)+first()+subscribe 3103.12 ns 0.23 ns 0.30 ns 0.77
immediate_just(1,2)+last()+subscribe 2366.48 ns 0.23 ns 0.26 ns 0.86
immediate_just+take_last(1)+subscribe 2998.21 ns 69.54 ns 83.93 ns 0.83

Schedulers
name rxcpp rpp prev rpp ratio
immediate scheduler create worker + schedule 864.63 ns 2.58 ns 2.87 ns 0.90
current_thread scheduler create worker + schedule 1199.19 ns 35.92 ns 38.54 ns 0.93
current_thread scheduler create worker + schedule + recursive schedule 1983.83 ns 217.52 ns 242.94 ns 0.90

Transforming Operators
name rxcpp rpp prev rpp ratio
immediate_just+map(v*2)+subscribe 2130.59 ns 0.23 ns 0.26 ns 0.88
immediate_just+scan(10, std::plus)+subscribe 2359.82 ns 0.47 ns 0.55 ns 0.85
immediate_just+flat_map(immediate_just(v*2))+subscribe 5270.27 ns 343.82 ns 398.30 ns 0.86
immediate_just+buffer(2)+subscribe 2531.15 ns 68.61 ns 79.03 ns 0.87
immediate_just+window(2)+subscribe + subscsribe inner 5355.87 ns 1889.77 ns 2265.19 ns 0.83

Conditional Operators
name rxcpp rpp prev rpp ratio
immediate_just+take_while(false)+subscribe 2025.47 ns - - 0.00
immediate_just+take_while(true)+subscribe 2040.17 ns 0.23 ns 0.23 ns 0.97

Utility Operators
name rxcpp rpp prev rpp ratio
immediate_just(1)+subscribe_on(immediate)+subscribe 4691.68 ns 0.23 ns 0.30 ns 0.76

Combining Operators
name rxcpp rpp prev rpp ratio
immediate_just(immediate_just(1), immediate_just(1)) + merge() + subscribe 7499.47 ns 378.81 ns 435.86 ns 0.87
immediate_just(1) + merge_with(immediate_just(2)) + subscribe 8095.35 ns 376.92 ns 420.10 ns 0.90
immediate_just(1) + with_latest_from(immediate_just(2)) + subscribe - 392.08 ns 427.76 ns 0.92
immediate_just(immediate_just(1),immediate_just(1)) + switch_on_next() + subscribe 7660.04 ns 1333.34 ns 1513.11 ns 0.88

Subjects
name rxcpp rpp prev rpp ratio
publish_subject with 1 observer - on_next 71.47 ns 68.06 ns 85.20 ns 0.80

Scenarios
name rxcpp rpp prev rpp ratio
basic sample 2617.12 ns 105.57 ns 130.88 ns 0.81
basic sample with immediate scheduler 2679.94 ns 14.53 ns 17.90 ns 0.81

Aggregating Operators
name rxcpp rpp prev rpp ratio
immediate_just+reduce(10, std::plus)+subscribe 2288.87 ns 0.22 ns 0.30 ns 0.75

ci-ubuntu-clang

General
name rxcpp rpp prev rpp ratio
Subscribe empty callbacks to empty observable 269.85 ns 0.88 ns 0.88 ns 1.00
Subscribe empty callbacks to empty observable via pipe operator 268.29 ns 0.88 ns 0.88 ns 1.00

Sources
name rxcpp rpp prev rpp ratio
from array of 1 - create + subscribe + immediate 564.02 ns 0.31 ns 0.31 ns 1.00
from array of 1 - create + subscribe + current_thread 788.92 ns 5.56 ns 5.55 ns 1.00
concat_as_source of just(1 immediate) create + subscribe 1860.51 ns 71.67 ns 72.79 ns 0.98
defer from array of 1 - defer + create + subscribe + immediate 575.72 ns 0.31 ns 0.31 ns 1.00
interval - interval + take(3) + subscribe + immediate 1523.94 ns 57.08 ns 57.09 ns 1.00
interval - interval + take(3) + subscribe + current_thread 2150.98 ns 30.88 ns 30.86 ns 1.00

Filtering Operators
name rxcpp rpp prev rpp ratio
immediate_just+take(1)+subscribe 929.94 ns 0.31 ns 0.31 ns 1.00
immediate_just+filter(true)+subscribe 646.74 ns 0.31 ns 0.31 ns 1.00
immediate_just(1,2)+skip(1)+subscribe 853.03 ns 0.31 ns 0.31 ns 1.00
immediate_just(1,1,2)+distinct_until_changed()+subscribe 691.38 ns 0.31 ns 0.31 ns 1.00
immediate_just(1,2)+first()+subscribe 1069.46 ns 0.31 ns 0.31 ns 1.00
immediate_just(1,2)+last()+subscribe 752.39 ns 0.31 ns 0.31 ns 1.00
immediate_just+take_last(1)+subscribe 966.18 ns 0.31 ns 0.31 ns 1.00

Schedulers
name rxcpp rpp prev rpp ratio
immediate scheduler create worker + schedule 196.18 ns 0.88 ns 0.88 ns 0.99
current_thread scheduler create worker + schedule 301.73 ns 5.56 ns 5.56 ns 1.00
current_thread scheduler create worker + schedule + recursive schedule 620.52 ns 58.01 ns 58.26 ns 1.00

Transforming Operators
name rxcpp rpp prev rpp ratio
immediate_just+map(v*2)+subscribe 652.97 ns 0.31 ns 0.31 ns 1.00
immediate_just+scan(10, std::plus)+subscribe 709.00 ns 0.31 ns 0.31 ns 1.00
immediate_just+flat_map(immediate_just(v*2))+subscribe 1795.31 ns 78.14 ns 78.82 ns 0.99
immediate_just+buffer(2)+subscribe 1375.57 ns 14.20 ns 14.20 ns 1.00
immediate_just+window(2)+subscribe + subscsribe inner 2138.48 ns 591.00 ns 588.86 ns 1.00

Conditional Operators
name rxcpp rpp prev rpp ratio
immediate_just+take_while(false)+subscribe 643.87 ns - - 0.00
immediate_just+take_while(true)+subscribe 653.32 ns 0.31 ns 0.31 ns 1.00

Utility Operators
name rxcpp rpp prev rpp ratio
immediate_just(1)+subscribe_on(immediate)+subscribe 1558.60 ns 0.31 ns 0.31 ns 1.00

Combining Operators
name rxcpp rpp prev rpp ratio
immediate_just(immediate_just(1), immediate_just(1)) + merge() + subscribe 2490.79 ns 84.56 ns 86.30 ns 0.98
immediate_just(1) + merge_with(immediate_just(2)) + subscribe 2968.65 ns 93.47 ns 96.04 ns 0.97
immediate_just(1) + with_latest_from(immediate_just(2)) + subscribe - 79.25 ns 80.51 ns 0.98
immediate_just(immediate_just(1),immediate_just(1)) + switch_on_next() + subscribe 2606.40 ns 554.31 ns 548.31 ns 1.01

Subjects
name rxcpp rpp prev rpp ratio
publish_subject with 1 observer - on_next 26.17 ns 24.35 ns 24.50 ns 0.99

Scenarios
name rxcpp rpp prev rpp ratio
basic sample 1049.83 ns 13.59 ns 13.60 ns 1.00
basic sample with immediate scheduler 1028.73 ns 6.17 ns 6.17 ns 1.00

Aggregating Operators
name rxcpp rpp prev rpp ratio
immediate_just+reduce(10, std::plus)+subscribe 745.63 ns 0.31 ns 0.31 ns 1.00

ci-windows

General
name rxcpp rpp prev rpp ratio
Subscribe empty callbacks to empty observable 572.86 ns 2.47 ns 3.09 ns 0.80
Subscribe empty callbacks to empty observable via pipe operator 592.60 ns 2.47 ns 3.09 ns 0.80

Sources
name rxcpp rpp prev rpp ratio
from array of 1 - create + subscribe + immediate 1176.18 ns 4.93 ns 4.94 ns 1.00
from array of 1 - create + subscribe + current_thread 1434.65 ns 19.76 ns 19.77 ns 1.00
concat_as_source of just(1 immediate) create + subscribe 4672.95 ns 154.81 ns 169.76 ns 0.91
defer from array of 1 - defer + create + subscribe + immediate 1212.00 ns 4.94 ns 4.93 ns 1.00
interval - interval + take(3) + subscribe + immediate 2956.32 ns 129.62 ns 131.38 ns 0.99
interval - interval + take(3) + subscribe + current_thread 3461.49 ns 59.91 ns 60.69 ns 0.99

Filtering Operators
name rxcpp rpp prev rpp ratio
immediate_just+take(1)+subscribe 1847.76 ns 12.87 ns 12.87 ns 1.00
immediate_just+filter(true)+subscribe 1353.03 ns 12.32 ns 12.32 ns 1.00
immediate_just(1,2)+skip(1)+subscribe 2148.11 ns 13.48 ns 13.05 ns 1.03
immediate_just(1,1,2)+distinct_until_changed()+subscribe 1382.43 ns 15.83 ns 15.93 ns 0.99
immediate_just(1,2)+first()+subscribe 2409.64 ns 12.64 ns 12.96 ns 0.98
immediate_just(1,2)+last()+subscribe 1507.27 ns 14.11 ns 14.09 ns 1.00
immediate_just+take_last(1)+subscribe 2067.92 ns 59.02 ns 59.44 ns 0.99

Schedulers
name rxcpp rpp prev rpp ratio
immediate scheduler create worker + schedule 496.81 ns 4.94 ns 4.94 ns 1.00
current_thread scheduler create worker + schedule 679.56 ns 16.05 ns 17.59 ns 0.91
current_thread scheduler create worker + schedule + recursive schedule 1101.50 ns 106.27 ns 106.10 ns 1.00

Transforming Operators
name rxcpp rpp prev rpp ratio
immediate_just+map(v*2)+subscribe 1359.77 ns 12.34 ns 12.34 ns 1.00
immediate_just+scan(10, std::plus)+subscribe 1448.05 ns 21.59 ns 21.27 ns 1.02
immediate_just+flat_map(immediate_just(v*2))+subscribe 3528.76 ns 198.63 ns 201.59 ns 0.99
immediate_just+buffer(2)+subscribe 2656.22 ns 61.94 ns 61.00 ns 1.02
immediate_just+window(2)+subscribe + subscsribe inner 4064.31 ns 1111.19 ns 1083.42 ns 1.03

Conditional Operators
name rxcpp rpp prev rpp ratio
immediate_just+take_while(false)+subscribe 1615.61 ns 11.46 ns 11.45 ns 1.00
immediate_just+take_while(true)+subscribe 1357.46 ns 12.32 ns 12.33 ns 1.00

Utility Operators
name rxcpp rpp prev rpp ratio
immediate_just(1)+subscribe_on(immediate)+subscribe 3161.81 ns 7.71 ns 7.71 ns 1.00

Combining Operators
name rxcpp rpp prev rpp ratio
immediate_just(immediate_just(1), immediate_just(1)) + merge() + subscribe 5168.49 ns 239.52 ns 242.58 ns 0.99
immediate_just(1) + merge_with(immediate_just(2)) + subscribe 6454.29 ns 212.03 ns 212.81 ns 1.00
immediate_just(1) + with_latest_from(immediate_just(2)) + subscribe - 219.41 ns 219.46 ns 1.00
immediate_just(immediate_just(1),immediate_just(1)) + switch_on_next() + subscribe 6207.27 ns 739.43 ns 743.09 ns 1.00

Subjects
name rxcpp rpp prev rpp ratio
publish_subject with 1 observer - on_next 36.04 ns 36.40 ns 36.10 ns 1.01

Scenarios
name rxcpp rpp prev rpp ratio
basic sample 1896.46 ns 60.47 ns 59.80 ns 1.01
basic sample with immediate scheduler 1907.21 ns 35.20 ns 36.72 ns 0.96

Aggregating Operators
name rxcpp rpp prev rpp ratio
immediate_just+reduce(10, std::plus)+subscribe 1794.67 ns 19.99 ns 20.06 ns 1.00

@codecov

codecov Bot commented Dec 22, 2023

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (a96a5e2) 95.54% compared to head (a096744) 95.54%.

Additional details and impacted files 
@@           Coverage Diff           @@
##               v2     #497   +/-   ##
=======================================
  Coverage   95.54%   95.54%           
=======================================
  Files          76       76           
  Lines        1906     1906           
=======================================
  Hits         1821     1821           
  Misses         85       85

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@sonarqubecloud

sonarqubecloud Bot commented Dec 22, 2023

Copy link
Copy Markdown

Quality Gate Passed Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

@AlexInLog AlexInLog marked this pull request as ready for review December 22, 2023 15:04
@AlexInLog AlexInLog merged commit 085140d into v2 Dec 22, 2023
@AlexInLog AlexInLog deleted the extend_doc branch December 22, 2023 15:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@AlexInLog